Skip to content

Conversation

@luancazarine
Copy link
Collaborator

@luancazarine luancazarine commented May 20, 2025

Resolves #16687.

Summary by CodeRabbit

  • New Features

    • Added the ability to generate PDF documents from HTML content or from templates, with options for customization.
    • Introduced support for converting generated documents to images (PNG), saving results to S3, and running tasks asynchronously with webhook notifications.
    • Provided new configuration options for S3 storage, file naming, and webhook URLs.
    • Enhanced integration with the pdforge API for document generation.
  • Bug Fixes

    • Corrected package configuration and dependency declarations.
  • Documentation

    • Included links to relevant documentation for HTML-to-PDF conversion and PDF parameter options.

@luancazarine luancazarine added the ai-assisted Content generated by AI, with human refinement and modification label May 20, 2025
@vercel
Copy link

vercel bot commented May 20, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Ignored (Inspect) Visit Preview May 21, 2025 5:57pm
pipedream-docs ⬜️ Ignored (Inspect) May 21, 2025 5:57pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) May 21, 2025 5:57pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 20, 2025

Walkthrough

This update introduces a new integration for pdforge, providing two actions: generating PDFs from HTML or from templates. It includes a reusable action base, utility functions, and a fully implemented app definition with authentication, S3, webhook support, and both synchronous and asynchronous API flows. Package dependencies and metadata are also updated.

Changes

File(s) Change Summary
components/pdforge/actions/common/base.mjs New base action module with properties and logic for handling PDF/PNG generation, async mode, S3 storage, and webhook notifications.
components/pdforge/actions/generate-pdf-from-html/generate-pdf-from-html.mjs New action to generate PDFs from HTML, supporting optional PDF parameters, async mode, S3, and webhooks.
components/pdforge/actions/generate-pdf-from-template/generate-pdf-from-template.mjs New action to generate PDFs from templates, supporting template variables, async mode, S3, and webhooks.
components/pdforge/common/utils.mjs New utility module providing functions for temp path normalization, safe JSON parsing, and recursive object cleaning.
components/pdforge/pdforge.app.mjs Expanded app definition with authentication, prop definitions for S3 and webhook, and methods for making requests to pdforge API, including synchronous and asynchronous flows.
components/pdforge/package.json Updated package version, added dependencies for platform, stream, and util modules, and fixed JSON structure.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Action (generate-pdf)
    participant pdforge.app
    participant pdforge API
    participant S3 (optional)
    participant Webhook (optional)

    User->>Action (generate-pdf): Provide input (HTML/template, options)
    Action (generate-pdf)->>pdforge.app: Call generatePDFfromHTML or generateDocumentFromTemplate
    pdforge.app->>pdforge API: POST request (sync/async based on webhook)
    alt Async (webhook provided)
        pdforge API-->>Webhook: Notify completion
        Action (generate-pdf)-->>User: Return async summary
    else Sync
        pdforge API-->>pdforge.app: Return file URL or S3 info
        alt Save to S3
            pdforge API-->>S3: Store file
            Action (generate-pdf)-->>User: Return S3 details
        else Download file
            pdforge.app->>Action (generate-pdf): Provide file URL
            Action (generate-pdf)->>User: Return file path and summary
        end
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Implement generate-pdf-from-template action with templateId, data, convertToImage, s3Bucket, s3Key, webhook (#16687)
Implement generate-pdf-from-html action with html, pdfParams, convertToImage, s3Bucket, s3Key, webhook (#16687)
Support both synchronous and asynchronous (webhook) flows for both actions (#16687)
Handle S3 storage and file download logic as described in pdforge docs (#16687)

Poem

In the warren we code, with PDFs we play,
HTML or template—just a hop away!
Async or sync, to S3 we send,
Webhooks and options, the features don’t end.
With utils and flows, this rabbit’s delight—
PDFs from pdforge, working just right!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

components/pdforge/actions/common/base.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:799:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:723:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:706:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:307:38)
at #link (node:internal/modules/esm/module_job:163:49)

components/pdforge/actions/generate-pdf-from-html/generate-pdf-from-html.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:799:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:723:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:706:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:307:38)
at #link (node:internal/modules/esm/module_job:163:49)

components/pdforge/actions/generate-pdf-from-template/generate-pdf-from-template.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:799:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:723:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:706:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:307:38)
at #link (node:internal/modules/esm/module_job:163:49)

  • 2 others

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Actions
 - Generate PDF From HTML
 - Generate PDF From TEMPLATE
@luancazarine luancazarine marked this pull request as ready for review May 21, 2025 18:05
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (7)
components/pdforge/common/utils.mjs (1)

33-48: Optimize clearObj function to avoid O(n²) complexity

The spread syntax in the accumulator of reduce() can lead to O(n²) time complexity for large objects, as flagged by static analysis.

Consider refactoring to avoid the spread operator on the accumulator:

export const clearObj = (obj) => {
  return Object.entries(obj)
    .filter(([, v]) => (v != null && v != "" && JSON.stringify(v) != "{}"))
    .reduce((acc, [k, v]) => {
-     return {
-       ...acc,
-       [k]: (!Array.isArray(v) && v === Object(v))
-         ? clearObj(v)
-         : v,
-     };
+     acc[k] = (!Array.isArray(v) && v === Object(v))
+       ? clearObj(v)
+       : v;
+     return acc;
    }, {});
};
🧰 Tools
🪛 Biome (1.9.4)

[error] 43-43: Avoid the use of spread (...) syntax on accumulators.

Spread syntax should be avoided on accumulators (like those in .reduce) because it causes a time complexity of O(n^2).
Consider methods such as .splice or .push instead.

(lint/performance/noAccumulatingSpread)

components/pdforge/actions/common/base.mjs (1)

79-92: Remove redundant webhook assignment

The webhook property is being set twice (once in the initial data object and again in the asyncMode condition).

const data = {
  ...this.getAdditionalData(),
  convertToImage: this.convertToImage,
  webhook: this.webhook,
};

if (this.saveS3) {
  data.s3Bucked = this.s3Bucked;
  data.s3Key = this.s3Key;
}

if (this.asyncMode) {
-  data.webhook = this.webhook;
}
components/pdforge/actions/generate-pdf-from-html/generate-pdf-from-html.mjs (2)

8-8: Consider adding more details to documentation link

The documentation link is helpful, but it would be more user-friendly to specify what information can be found there (e.g., "See the documentation for API details and examples").


35-39: Improve success message with file details

The success message is clear but could be enhanced by including more details about the generated file, such as file name or size if available from the response.

  getSummary({ convertToImage }) {
    return `${convertToImage
      ? "PNG"
      : "PDF"} successfully generated from provided HTML content.`;
  },
components/pdforge/pdforge.app.mjs (3)

21-21: Fix typo in description

There's a typo in the fileName description: "direcrtory" should be "directory".

-  description: "The filename without extension for saving the file in the `/tmp` direcrtory",
+  description: "The filename without extension for saving the file in the `/tmp` directory",

6-27: Add validation for URL and file properties

Consider adding validation for the webhook URL format and potentially for S3 bucket naming patterns to prevent runtime errors.

For the webhook property, you could add:

  webhook: {
    type: "string",
    label: "Webhook URL",
    description: "The URL of your webhook endpoint",
+   pattern: "^https?://.*",
+   validatePattern: true,
  },

40-48: Add error handling to request method

The _makeRequest method could benefit from error handling to provide more descriptive error messages specific to pdforge API errors.

  _makeRequest({
    $ = this, baseUrl, removeHeader, path = "", ...opts
  }) {
-   return axios($, {
-     url: this._baseUrl(baseUrl) + path,
-     headers: this._headers(removeHeader),
-     ...opts,
-   });
+   return axios($, {
+     url: this._baseUrl(baseUrl) + path,
+     headers: this._headers(removeHeader),
+     ...opts,
+   }).catch(err => {
+     const status = err.response?.status;
+     const message = err.response?.data?.message || err.message;
+     throw new Error(`pdforge API error (${status}): ${message}`);
+   });
  },
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 375489e and 0da3fef.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (6)
  • components/pdforge/actions/common/base.mjs (1 hunks)
  • components/pdforge/actions/generate-pdf-from-html/generate-pdf-from-html.mjs (1 hunks)
  • components/pdforge/actions/generate-pdf-from-template/generate-pdf-from-template.mjs (1 hunks)
  • components/pdforge/common/utils.mjs (1 hunks)
  • components/pdforge/package.json (2 hunks)
  • components/pdforge/pdforge.app.mjs (1 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
components/pdforge/common/utils.mjs

[error] 43-43: Avoid the use of spread (...) syntax on accumulators.

Spread syntax should be avoided on accumulators (like those in .reduce) because it causes a time complexity of O(n^2).
Consider methods such as .splice or .push instead.

(lint/performance/noAccumulatingSpread)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Verify TypeScript components
  • GitHub Check: pnpm publish
  • GitHub Check: Publish TypeScript components
🔇 Additional comments (8)
components/pdforge/actions/generate-pdf-from-template/generate-pdf-from-template.mjs (1)

1-40: Implementation looks good!

The action is well-structured and properly extends the common base component. Good job on clearly defined props with descriptive labels and using the parseObject utility for data formatting.

components/pdforge/common/utils.mjs (1)

1-31: Well-implemented utility functions

The checkTmp and parseObject functions are well-designed with proper error handling and edge case coverage.

components/pdforge/actions/common/base.mjs (2)

10-75: Props and dynamic visibility management look good

The component's props are well-defined with clear labels and descriptions. The additionalProps method effectively controls property visibility based on the selected mode.


76-133: Implement file handling correctly

The file handling logic for non-async, non-S3 modes is well implemented using proper stream handling and file system operations.

components/pdforge/actions/generate-pdf-from-html/generate-pdf-from-html.mjs (1)

1-41: Well-structured PDF generation action component

This action component for generating PDFs from HTML content is well-designed. It properly extends the common base, defines appropriate properties, and implements the necessary methods to integrate with the pdforge API.

The component:

  • Clearly separates input concerns (HTML content and PDF parameters)
  • Properly parses object parameters
  • Provides descriptive documentation links
  • Returns appropriate success messages based on the output type
components/pdforge/pdforge.app.mjs (3)

1-48: Well-implemented API client setup

The API client setup is well-structured with appropriate helper methods for:

  • Base URL handling with default value
  • Authentication headers
  • Request abstraction using axios

This follows good practices for code organization and reuse.


16-16: Reconsider if s3key should be marked as secret

The s3key property is marked as secret, but since it's typically just a path and filename, it may not need to be treated as sensitive information unless it contains confidential naming patterns.


49-70: Well-implemented API method handlers

The API methods for generating documents from templates and HTML content are well-implemented. They:

  • Handle both synchronous and asynchronous modes
  • Properly pass through options to the request method
  • Use clear endpoint paths

@luancazarine luancazarine merged commit 80d7d08 into master May 22, 2025
11 checks passed
@luancazarine luancazarine deleted the issue-16687 branch May 22, 2025 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-assisted Content generated by AI, with human refinement and modification

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Components] pdforge

3 participants